post /mint/organizations/{org_name}/transactions

Migrates existing transactions or fees. See also Migrating developers to monetization.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transactions

Path Parameters

org_name (required)

string

Organization name.

Query Parameters

force

boolean

Flag that specifies whether to skip validation steps and forcibly set the number of transactions. By default, ?force=false and validation steps are executed. For example, if a prepaid developer has a zero balance and activity on the account is suspended, if ?force=false the request will fail during validation.

Request Body

Migration details.

application/json
TransactionsMigrate
application

object

id

string

ID of the application. Required only when migrating a batch transaction; not required when charging fees.

batchSize

integer

When migrating transactions, specifies the number of transactions that you want to transfer. Defaults to 1. Required only when migrating a batch transaction; not required when charging fees.

custAttn

number

When migrating transactions, specifies the value of the custom attribute that is used with batchSize to calculate the transaction usage. The custom attribute number in the message must be specified as a positive whole or decimal (up to four decimal places) value. Negative values are not allowed. The custom attribute must be defined in either the transaction recording policy for the API product or the active rate plan for the API product. Required only when migrating a batch transaction; not required when charging fees.

currency

any

if type is: object
id

string

Currency used for the rate plan. Specify the ISO 4217 code for the currency, such as usd for United States dollar or chf for Swiss franc. Required only when charging a setup or recurring fee; not required when migrating a batch transaction.

developer

object

id

string

ID of the developer. Required only when charging a setup or recurring fee; not required when migrating a batch transaction.

product

object

id

string

ID of the API product. Required only when migrating a batch transaction; not required when charging a setup or recurring fee.

rate

number

Setup or recurring fee to charge. Required only when charging a setup or recurring fee; not required when migrating a batch transaction.

ratePlan

object

id

string

ID of the rate plan. Required only when charging a setup or recurring fee; not required when migrating a batch transaction.

type

string

Type of migration. Valid values include: CHARGE, SETUPFEES, or RECURRINGFEES. Defaults to CHARGE. Required only when charging setup or recurring fees.

Response Types

201: 

Created

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
force
Request body
For suggestions, press control+space or click one of the blue "add" circles.
Credentials
Multi-factor authentication is not supported.